Skip to content

docs(jupyterhub): sync template standards updates#356

Open
mberlofa wants to merge 1 commit into
mainfrom
docs/jupyterhub-template-standards-sync
Open

docs(jupyterhub): sync template standards updates#356
mberlofa wants to merge 1 commit into
mainfrom
docs/jupyterhub-template-standards-sync

Conversation

@mberlofa

@mberlofa mberlofa commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

Summary

  • sync JupyterHub docs with the template-standards chart update
  • expose networkPolicy.extraEgress in the JupyterHub playground controls
  • mark JupyterHub as a curated playground config for site-sync tracking

Validation

  • npm run lint
  • npm run format:check
  • npm run build
  • make site-sync-check CHART=jupyterhub

Related charts PR: helmforgedev/charts#678

Summary by CodeRabbit

  • New Features

    • Added new network policy options for the JupyterHub chart, including an extra egress CIDR and port.
    • JupyterHub is now available in the playground chart list.
  • Documentation

    • Improved formatting of the JupyterHub chart values table for easier reading.

@coderabbitai

coderabbitai Bot commented Jul 4, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Adds two new NetworkPolicy extraEgress fields (CIDR and port) to the jupyterhub playground configuration, adds jupyterhub to the site-synced playground chart allowlist, and reformats the jupyterhub docs Values table for column alignment.

Changes

JupyterHub playground egress support

Layer / File(s) Summary
Playground config fields and allowlist wiring
src/data/playground-configs.ts, src/pages/playground.astro
Adds networkPolicy.extraEgress CIDR and port field definitions with defaults to the jupyterhub playground config, and adds jupyterhub to siteSyncPlaygroundConfigs so it's included in playgroundCharts.
Docs table formatting
src/pages/docs/charts/jupyterhub.mdx
Reformats spacing/alignment of the Values parameter table without changing parameter names, defaults, or descriptions.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning Summary and validation are present, but the required Quality Gates checklist, Related Issue section, and template structure are missing. Add the template's Quality Gates checkbox list and Related Issue section, and align the description to the repository template.
✅ Passed checks (4 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly summarizes the docs-focused JupyterHub template sync reflected by the changeset.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/jupyterhub-template-standards-sync

Comment @coderabbitai help to get the list of available commands.

mberlofa added a commit to helmforgedev/charts that referenced this pull request Jul 6, 2026
## Summary
- Keep the JupyterHub Helm test hook under `templates/tests/` so `helm
test` renders and executes it, with unittest coverage restored.
- Add `networkPolicy.extraEgress` as an additive Hub egress alias while
preserving `networkPolicy.hub.egress`.
- Rewrite NOTES into numbered operational sections and update
README/schema/unit coverage.

## Related
- Site sync: helmforgedev/site#356.
- Closes part of #633.

## Validation
- `helm template test charts/jupyterhub | rg -n
"helm.sh/hook|test-connection"` (hook rendered from
`templates/tests/test-connection.yaml`)
- `helm unittest charts/jupyterhub` (69 tests, 9 suites)
- `make template-standards-check CHART=jupyterhub`
- `node scripts/charts/validate-chart.js --chart jupyterhub --no-k3d`
- `make validate-chart CHART=jupyterhub TIMEOUT=900` (FULLY VALIDATED,
19 layers)
- `make release-check REPO=charts`
- `make attribution-check REPO=charts`

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Added support for `networkPolicy.hub.extraEgress` to append additional
Hub egress rules while keeping the default egress behavior.
* **Bug Fixes**
* Updated generated NetworkPolicy output to include the additional
egress rules in the rendered `spec.egress`.
* **Documentation**
* Refreshed chart documentation and generated notes to describe the new
extra egress setting.
* **Tests**
* Extended the NetworkPolicy test coverage to verify the appended egress
rule is generated as expected.
* **Chores**
* Improved NetworkPolicy value validation by defining the new
`extraEgress` structure.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: MergeCheck <mergecheck@example.invalid>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant